Api.ReadInputBit method

Reads a bit from an input of a real or simulated I/O module.

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsReturn<bool> ReadInputBit(
       int Index,
       int BitOffset
)

Public Function ReadInputBit(
       Index As Integer,
       BitOffset As Integer
) As KsReturn(Of Boolean)

Parameters

Index

Type: int

The index of an I/O module. Indexes are zero based. Aliases affect this parameter.

BitOffset

Type: int

Specifies a bit offset to the location to read a bit value. The max offset is determined by InputLength in the SlaveStatus class.

Return value

Returns a KsError code and a bool value.

Remarks

ReadInputBit can only be called once a link is established and started.

Usable EtherCAT states

ecatOP

Examples

N/A